<?php
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 *
 * Base interface for all message objects.
 *
 * see
 * http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message
 *
 */
class osapiMessage {
  public $recipients;
  public $body;
  public $title;
  public $type;
  public $types = array(
	    /* An email */
	    'EMAIL',
	    /* A short private message */
	    'NOTIFICATION',
	    /* A message to a specific user that can be seen only by that user */
	    'PRIVATE_MESSAGE',
	    /* A message to a specific user that can be seen by more than that user */
	    'PUBLIC_MESSAGE');

  public function __construct($recipients, $initBody, $initTitle, $initType = 'PRIVATE_MESSAGE') {
    if (!is_array($recipients)) {
      throw new osapiException("recipients should be an array with user id's");
    }
    $this->setRecipients($recipients);
    $this->setBody($initBody);
    $this->setTitle($initTitle);
    $this->setType($initType);
  }

  public function setRecipients($recipients) {
    $this->recipients = $recipients;
  }

  public function getRecipients() {
    return $this->recipients;
  }

  /**
   * Gets the main text of the message.
   * @return the main text of the message
   */
  public function getBody() {
    return $this->body;
  }

  /**
   * Sets the main text of the message.
   * HTML attributes are allowed and are sanitized by the container
   * @param newBody the main text of the message
   */
  public function setBody($newBody) {
    $this->body = $newBody;
  }

  /**
   * Gets the title of the message
   * @return the title of the message
   */
  public function getTitle() {
    return $this->title;
  }

  /**
   * Sets the title of the message
   * HTML attributes are allowed and are sanitized by the container.
   * @param newTitle the title of the message
   */
  public function setTitle($newTitle) {
    $this->title = $newTitle;
  }

  /**
   * Gets the type of the message, as specified by opensocial.Message.Type
   * @return the type of message (enum Message.Type)
   */
  public function getType() {
    return $this->type;
  }

  /**
   * Sets the type of the message, as specified by opensocial.Message.Type
   * @param newType the type of message (enum Message.Type)
   */
  public function setType($newType) {
    if (! in_array($newType, $this->types)) {
      throw new Exception('Invalid message type');
    }
    $this->type = $newType;
  }

  /**
   * TODO implement either a standard 'sanitizing' facility or
   * define an interface that can be set on this class so
   * others can plug in their own.
   * @param htmlStr String to be sanitized.
   * @return the sanitized HTML String
   */
  public function sanitizeHTML($htmlStr) {
    return $htmlStr;
  }
}
